/*
 * Copyright (c) 2012 Jonathan Tyers
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.org.uplink.configproxy;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Denotes a ConfigProxy interface. Interfaces with this annotation should contain methods with the {@code @}{@link ConfigValue} annotation. At
 * runtime, these methods will be used to provide access to an underlying configuration.
 * <p>
 * Implementations of {@code @}ConfigProxy interfaces are provided by the {@link ConfigProxyFactory}.
 * 
 * @see ConfigProxyFactory
 * @author jonny
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ConfigProxy {

	/**
	 * The base key for all values in this configuration. The base key is prepended to the keys of {@link ConfigValue}s when those keys are looked up
	 * against the Apache commons configuration.
	 */
	String basekey() default "";

}
